/**
 * Copyright (c) 2008, Mu Dynamics.
 *  All rights reserved.
 *  
 *   Redistribution and use in source and binary forms, with or without modification, 
 *   are permitted provided that the following conditions are met:
 *   
 *  - Redistributions of source code must retain the above copyright notice, 
 *     this list of conditions and the following disclaimer.
 *  - Redistributions in binary form must reproduce the above copyright notice, 
 *     this list of conditions and the following disclaimer in the documentation and/or 
 *     other materials provided with the distribution.
 *  - Neither the name of the "Mu Dynamics" nor the names of its contributors may be used 
 *     to endorse  or promote products derived from this software without specific prior 
 *     written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 * THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.mu.jacob.core.model.decorator;

import java.util.Arrays;
import java.util.Collection;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;

import javax.lang.model.element.Element;
import javax.lang.model.element.ElementKind;

import com.mu.jacob.core.generator.Decorate;

/**
 * Filter util class contains element and type filter
 * @author Adam Smyczek
 *
 */
public class Filter {

	/**
	 * Filter elements based on element kind
	 * @param <E>
	 * @param elements to filter set
	 * @param elementType the type of the elements, mostly same as <E>
	 * @param elemtentKinds the array of element kinds to filter on
	 * @return returns a set with elements of kind elementKiinds
	 */
	@Decorate
    public static <E extends Element> Set<E> filterElements(
    		Collection<? extends Element> elements,
    		Class<E> elementType,
    		ElementKind... elemtentKinds) {
    	List<ElementKind> kinds = Arrays.<ElementKind>asList(elemtentKinds);
    	Set<E> set = new LinkedHashSet<E>();
    	for (Element element : elements) {
    		if (kinds.contains(element.getKind()))
    			set.add(elementType.cast(element));
    	}
    	return set;
    }

    /**
     * Filter elements based on element kind
     * @param elements to filter set
     * @param elemtentKinds 
     * @return returns a set with elements of kind elementKiinds
     */
	@Decorate
    public static Set<Element> filterElements(
    		Collection<? extends Element> elements,
    		ElementKind... elemtentKinds) {
    	List<ElementKind> kinds = Arrays.<ElementKind>asList(elemtentKinds);
    	Set<Element> set = new LinkedHashSet<Element>();
    	for (Element element : elements) {
    		if (kinds.contains(element.getKind()))
    			set.add(element);
    	}
    	return set;
    }
    
}
